IApi.EnableHotConnect method

Allows new hardware to be added while the EtherCAT network is running.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsError EnableHotConnect(
       bool Active
)

Function EnableHotConnect(
       Active As Boolean
) As KsError

Parameters

Active

Type: bool

true to enable, and false to disable Hot Connect. By default, it is false.

Return value

A return code of a method.

Remarks

This method must be called after Create or CreateAsync and before Start.
This feature requires Hot Connect Package.
For more information about how HotConnect, AutoRepair, and AutoRestart work, see Concepts > HotConnect, Repair, and Restart.

Usable EtherCAT states

ecatOffline

Examples

N/A